<?php
// $Id: FloatValue.class.php 73 2007-02-12 03:45:43Z tswicegood $
/**
 * This file contains {@link FloatValue} which is part of the PHP Content 
 * Repository (phpCR), a derivative of the Java Content Repository JSR-170, and 
 * is licensed under the Apache License, Version 2.0.
 *
 * This file is based on the code created for
 * {@link http://www.jcp.org/en/jsr/detail?id=170 JSR-170}
 *
 * @author Travis Swicegood <travis@domain51.net>
 * @copyright PHP Code Copyright &copy; 2004-2005, Domain51, United States
 * @copyright Original Java and Documentation 
 *  Copyright &copy; 2002-2004, Day Management AG, Switerland
 * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, 
 *      Version 2.0
 * @package phpContentRepository
 */

/**
 * Load the {@link phpCR} library file(s)
 */ 
require_once(dirname(__FILE__) . '/phpCR.library.php');
phpCR::loadAbstract('BaseValue');
phpCR::loadClass('PropertyType');


/**
 * A {@link DoubleValue} provides an implementation
 * of the Value interface representing a double value.
 *
 * @author PHP - Travis Swicegood <travis@domain51.net>
 * @copyright Copyright &copy; 2004-2005, Domain51
 * @package phpContentRepository
 */
class FloatValue extends BaseValue 
{
   /**
    * Defines the {@link PropertType} of this class.
    *
    * @var int
    * @see PropertyType::FLOAT
    */
    const TYPE = PropertyType::FLOAT;
    
    
   /**
    * Constructs a {@link DoubleValue} object representing a double.
    *
    * @param dblNumber the double this {@link DoubleValue} should represent
    */
    public function __construct($dblNumber) {
        parent::__construct(self::TYPE);
        
        $this->data = floatval($dblNumber);
    }
    
    
   /**
    * Returns a new {@link DoubleValue} initialized to the value
    * represented by the specified String.
    *
    * @param mixed
    *   The value to be parsed.
    * @return a newly constructed {@link DoubleValue} representing the
    *         the specified value.
    * @throws {@link ValueFormatException}
    *   If the $value is an array or object.
    */
    static public function valueOf($value)
    {
        switch (gettype($value)) {
        case 'array' :
        case 'object' :
            phpCR::loadException('ValueFormat');
            throw new ValueFormatException('invalid format');
            break;
        
        default :
            return new DoubleValue($value);
            break;
        }
    }
    
    
   /**
    * Indicates whether some other object is "equal to" this one.
    *
    * The result is TRUE if and only if the argument is not
    * NULL and is a {@link DoubleValue} object that represents the
    * same value as this object.
    *
    * @param mixed
    *   The value with which to compare.
    * @return bool
    */
    public function equals($obj) 
    {
        if ($this == $obj) {
            return true;
        }
        if ($obj instanceof DoubleValue) {
            $objData = $obj->getData();
            if (is_null($objData)) {
                return false;
            }
            
            if ($this->data == $objData) {
                return true;
            }
        }
        return false;
    }
    
    
   /**
    * @see Value::getBoolean()
    */
    public function getBoolean() 
    {
        $this->setValueConsumed();
        
        phpCR::loadException('ValueFormat');
        throw new ValueFormatException("conversion to boolean failed: inconvertible types");
    }

}

